SGI Freeware 1999 August

home *** CD-ROM | disk | FTP | other *** search

/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_bash.idb / usr / freeware / catman / u_man / cat1 / builtins.Z / builtins

Wrap

Text File | 1999-04-16 | 84.7 KB | 1,519 lines

BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) NNNNAAAAMMMMEEEE bash, :, ., alias, bg, bind, break, builtin, case, cd, command, continue, declare, dirs, disown, echo, enable, eval, exec, exit, export, fc, fg, for, getopts, hash, help, history, if, jobs, kill, let, local, logout, popd, pushd, pwd, read, readonly, return, set, shift, shopt, source, suspend, test, times, trap, type, typeset, ulimit, umask, unalias, unset, until, wait, while - bash built-in commands, see bbbbaaaasssshhhh(1) BBBBAAAASSSSHHHH BBBBUUUUIIIILLLLTTTTIIIINNNN CCCCOOOOMMMMMMMMAAAANNNNDDDDSSSS Unless otherwise noted, each builtin command documented in this section as accepting options preceded by ---- accepts -------- to signify the end of the options. :::: [_a_r_g_u_m_e_n_t_s] No effect; the command does nothing beyond expanding _a_r_g_u_m_e_n_t_s and performing any specified redirections. A zero exit code is returned. .... _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] ssssoooouuuurrrrcccceeee _f_i_l_e_n_a_m_e [_a_r_g_u_m_e_n_t_s] Read and execute commands from _f_i_l_e_n_a_m_e in the current shell environment and return the exit status of the last command executed from _f_i_l_e_n_a_m_e. If _f_i_l_e_n_a_m_e does not contain a slash, file names in PPPPAAAATTTTHHHH are used to find the directory containing _f_i_l_e_n_a_m_e. The file searched for in PPPPAAAATTTTHHHH need not be executable. The current directory is searched if no file is found in PPPPAAAATTTTHHHH. If the ssssoooouuuurrrrcccceeeeppppaaaatttthhhh option to the sssshhhhoooopppptttt builtin command is turned off, the PPPPAAAATTTTHHHH is not searched. If any _a_r_g_u_m_e_n_t_s are supplied, they become the positional parameters when _f_i_l_e_n_a_m_e is executed. Otherwise the positional parameters are unchanged. The return status is the status of the last command exited within the script (0 if no commands are executed), and false if _f_i_l_e_n_a_m_e is not found or cannot be read. aaaalllliiiiaaaassss [----pppp] [_n_a_m_e[=_v_a_l_u_e] ...] AAAAlllliiiiaaaassss with no arguments or with the ----pppp option prints the list of aliases in the form aaaalllliiiiaaaassss _n_a_m_e=_v_a_l_u_e on standard output. When arguments are supplied, an alias is defined for each _n_a_m_e whose _v_a_l_u_e is given. A trailing space in _v_a_l_u_e causes the next word to be checked for alias substitution when the alias is expanded. For each _n_a_m_e in the argument list for which no _v_a_l_u_e is supplied, the name and value of the alias is printed. AAAAlllliiiiaaaassss returns true unless a _n_a_m_e is given for which no alias has been defined. bbbbgggg [_j_o_b_s_p_e_c] Resume the suspended job _j_o_b_s_p_e_c in the background, as if it had been started with &&&&. If _j_o_b_s_p_e_c is not Page 1 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) present, the shell's notion of the _c_u_r_r_e_n_t _j_o_b is used. bbbbgggg _j_o_b_s_p_e_c returns 0 unless run when job control is disabled or, when run with job control enabled, if _j_o_b_s_p_e_c was not found or started without job control. bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] [----llllppppssssvvvvPPPPSSSSVVVV] bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] [----qqqq _f_u_n_c_t_i_o_n] [----uuuu _f_u_n_c_t_i_o_n] [----rrrr _k_e_y_s_e_q] bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] ----ffff _f_i_l_e_n_a_m_e bbbbiiiinnnndddd [----mmmm _k_e_y_m_a_p] _k_e_y_s_e_q:_f_u_n_c_t_i_o_n-_n_a_m_e Display current rrrreeeeaaaaddddlllliiiinnnneeee key and function bindings, or bind a key sequence to a rrrreeeeaaaaddddlllliiiinnnneeee function or macro. The binding syntax accepted is identical to that of ._i_n_p_u_t_r_c, but each binding must be passed as a separate argument; e.g., '"\C-x\C-r": re-read-init-file'. Options, if supplied, have the following meanings: ----mmmm _k_e_y_m_a_p Use _k_e_y_m_a_p as the keymap to be affected by the subsequent bindings. Acceptable _k_e_y_m_a_p names are _e_m_a_c_s, _e_m_a_c_s-_s_t_a_n_d_a_r_d, _e_m_a_c_s-_m_e_t_a, _e_m_a_c_s-_c_t_l_x, _v_i, _v_i-_c_o_m_m_a_n_d, and _v_i-_i_n_s_e_r_t. _v_i is equivalent to _v_i-_c_o_m_m_a_n_d; _e_m_a_c_s is equivalent to _e_m_a_c_s-_s_t_a_n_d_a_r_d. ----llll List the names of all rrrreeeeaaaaddddlllliiiinnnneeee functions. ----pppp Display rrrreeeeaaaaddddlllliiiinnnneeee function names and bindings in such a way that they can be re-read. ----PPPP List current rrrreeeeaaaaddddlllliiiinnnneeee function names and bindings. ----vvvv Display rrrreeeeaaaaddddlllliiiinnnneeee variable names and values in such a way that they can be re-read. ----VVVV List current rrrreeeeaaaaddddlllliiiinnnneeee variable names and values. ----ssss Display rrrreeeeaaaaddddlllliiiinnnneeee key sequences bound to macros and the strings they output in such a way that they can be re-read. ----SSSS Display rrrreeeeaaaaddddlllliiiinnnneeee key sequences bound to macros and the strings they output. ----ffff _f_i_l_e_n_a_m_e Read key bindings from _f_i_l_e_n_a_m_e. ----qqqq _f_u_n_c_t_i_o_n Query about which keys invoke the named _f_u_n_c_t_i_o_n. ----uuuu _f_u_n_c_t_i_o_n Unbind all keys bound to the named _f_u_n_c_t_i_o_n. ----rrrr _k_e_y_s_e_q Remove any current binding for _k_e_y_s_e_q. The return value is 0 unless an unrecognized option is given or an error occurred. bbbbrrrreeeeaaaakkkk [_n] Exit from within a ffffoooorrrr, wwwwhhhhiiiilllleeee, uuuunnnnttttiiiillll, or sssseeeelllleeeecccctttt loop. If _n is specified, break _n levels. _n must be _> 1. If _n is greater than the number of enclosing loops, all enclosing loops are exited. The return value is 0 unless the shell is not executing a loop when bbbbrrrreeeeaaaakkkk is executed. Page 2 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) bbbbuuuuiiiillllttttiiiinnnn _s_h_e_l_l-_b_u_i_l_t_i_n [_a_r_g_u_m_e_n_t_s] Execute the specified shell builtin, passing it _a_r_g_u_m_e_n_t_s, and return its exit status. This is useful when defining a function whose name is the same as a shell builtin, retaining the functionality of the builtin within the function. The ccccdddd builtin is commonly redefined this way. The return status is false if _s_h_e_l_l-_b_u_i_l_t_i_n is not a shell builtin command. ccccdddd [----LLLLPPPP] [_d_i_r] Change the current directory to _d_i_r. The variable HHHHOOOOMMMMEEEE is the default _d_i_r. The variable CCCCDDDDPPPPAAAATTTTHHHH defines the search path for the directory containing _d_i_r. Alternative directory names in CCCCDDDDPPPPAAAATTTTHHHH are separated by a colon (:). A null directory name in CCCCDDDDPPPPAAAATTTTHHHH is the same as the current directory, i.e., ``....''. If _d_i_r begins with a slash (/), then CCCCDDDDPPPPAAAATTTTHHHH is not used. The ----PPPP option says to use the physical directory structure instead of following symbolic links (see also the ----PPPP option to the sssseeeetttt builtin command); the ----LLLL option forces symbolic links to be followed. An argument of ---- is equivalent to $$$$OOOOLLLLDDDDPPPPWWWWDDDD. The return value is true if the directory was successfully changed; false otherwise. ccccoooommmmmmmmaaaannnndddd [----ppppVVVVvvvv] _c_o_m_m_a_n_d [_a_r_g ...] Run _c_o_m_m_a_n_d with _a_r_g_s suppressing the normal shell function lookup. Only builtin commands or commands found in the PPPPAAAATTTTHHHH are executed. If the ----pppp option is given, the search for _c_o_m_m_a_n_d is performed using a default value for PPPPAAAATTTTHHHH that is guaranteed to find all of the standard utilities. If either the ----VVVV or ----vvvv option is supplied, a description of _c_o_m_m_a_n_d is printed. The ----vvvv option causes a single word indicating the command or file name used to invoke _c_o_m_m_a_n_d to be displayed; the ----VVVV option produces a more verbose description. If the ----VVVV or ----vvvv option is supplied, the exit status is 0 if _c_o_m_m_a_n_d was found, and 1 if not. If neither option is supplied and an error occurred or _c_o_m_m_a_n_d cannot be found, the exit status is 127. Otherwise, the exit status of the ccccoooommmmmmmmaaaannnndddd builtin is the exit status of _c_o_m_m_a_n_d. ccccoooonnnnttttiiiinnnnuuuueeee [_n] Resume the next iteration of the enclosing ffffoooorrrr, wwwwhhhhiiiilllleeee, uuuunnnnttttiiiillll, or sssseeeelllleeeecccctttt loop. If _n is specified, resume at the _nth enclosing loop. _n must be _> 1. If _n is greater than the number of enclosing loops, the last enclosing loop (the ``top-level'' loop) is resumed. The return value is 0 unless the shell is not executing a loop when ccccoooonnnnttttiiiinnnnuuuueeee is executed. Page 3 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) ddddeeeeccccllllaaaarrrreeee [----aaaaffffFFFFiiiirrrrxxxx] [----pppp] [_n_a_m_e[=_v_a_l_u_e]] ttttyyyyppppeeeesssseeeetttt [----aaaaffffFFFFiiiirrrrxxxx] [----pppp] [_n_a_m_e[=_v_a_l_u_e]] Declare variables and/or give them attributes. If no _n_a_m_es are given then display the values of variables. The ----pppp option will display the attributes and values of each _n_a_m_e. When ----pppp is used, additional options are ignored. The ----FFFF option inhibits the display of function definitions; only the function name and attributes are printed. The ----FFFF option implies ----ffff. The following options can be used to restrict output to variables with the specified attribute or to give variables attributes: ----aaaa Each _n_a_m_e is an array variable (see AAAArrrrrrrraaaayyyyssss above). ----ffff Use function names only. ----iiii The variable is treated as an integer; arithmetic evaluation (see AAAARRRRIIIITTTTHHHHMMMMEEEETTTTIIIICCCC EEEEVVVVAAAALLLLUUUUAAAATTTTIIIIOOOONNNN )))) is performed when the variable is assigned a value. ----rrrr Make _n_a_m_es readonly. These names cannot then be assigned values by subsequent assignment statements or unset. ----xxxx Mark _n_a_m_es for export to subsequent commands via the environment. Using `+' instead of `-' turns off the attribute instead, with the exception that ++++aaaa may not be used to destroy an array variable. When used in a function, makes each _n_a_m_e local, as with the llllooooccccaaaallll command. The return value is 0 unless an invalid option is encountered, an attempt is made to define a function using "-f foo=bar", an attempt is made to assign a value to a readonly variable, an attempt is made to assign a value to an array variable without using the compound assignment syntax (see AAAArrrrrrrraaaayyyyssss above), one of the _n_a_m_e_s is not a valid shell variable name, an attempt is made to turn off readonly status for a readonly variable, an attempt is made to turn off array status for an array variable, or an attempt is made to display a non-existent function with -f. ddddiiiirrrrssss [[[[----ccccllllppppvvvv]]]] [[[[++++_n]]]] [[[[----_n]]]] Without options, displays the list of currently remembered directories. The default display is on a single line with directory names separated by spaces. Directories are added to the list with the ppppuuuusssshhhhdddd command; the ppppooooppppdddd command removes entries from the list. ++++_n Displays the _nth entry counting from the left of the list shown by ddddiiiirrrrssss when invoked without options, starting with zero. ----_n Displays the _nth entry counting from the right of the list shown by ddddiiiirrrrssss when invoked without options, starting with zero. Page 4 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) ----cccc Clears the directory stack by deleting all of the entries. ----llll Produces a longer listing; the default listing format uses a tilde to denote the home directory. ----pppp Print the directory stack with one entry per line. ----vvvv Print the directory stack with one entry per line, prefixing each entry with its index in the stack. The return value is 0 unless an invalid option is supplied or _n indexes beyond the end of the directory stack. ddddiiiissssoooowwwwnnnn [----aaaarrrr] [----hhhh] [_j_o_b_s_p_e_c ...] Without options, each _j_o_b_s_p_e_c is removed from the table of active jobs. If the ----hhhh option is given, each _j_o_b_s_p_e_c is not removed from the table, but is marked so that SSSSIIIIGGGGHHHHUUUUPPPP is not sent to the job if the shell receives a SSSSIIIIGGGGHHHHUUUUPPPP. If no _j_o_b_s_p_e_c is present, and neither the ----aaaa nor the ----rrrr option is supplied, the _c_u_r_r_e_n_t _j_o_b is used. If no _j_o_b_s_p_e_c is supplied, the ----aaaa option means to remove or mark all jobs; the ----rrrr option without a _j_o_b_s_p_e_c argument restricts operation to running jobs. The return value is 0 unless a _j_o_b_s_p_e_c does not specify a valid job. eeeecccchhhhoooo [----nnnneeeeEEEE] [_a_r_g ...] Output the _a_r_gs, separated by spaces, followed by a newline. The return status is always 0. If ----nnnn is specified, the trailing newline is suppressed. If the ----eeee option is given, interpretation of the following backslash-escaped characters is enabled. The ----EEEE option disables the interpretation of these escape characters, even on systems where they are interpreted by default. eeeecccchhhhoooo does not interpret -------- to mean the end of options. eeeecccchhhhoooo interprets the following escape sequences: \\\\aaaa alert (bell) \\\\bbbb backspace \\\\cccc suppress trailing newline \\\\eeee an escape character \\\\ffff form feed \\\\nnnn new line \\\\rrrr carriage return \\\\tttt horizontal tab \\\\vvvv vertical tab \\\\\\\\ backslash \\\\_n_n_n the character whose ASCII code is the octal value _n_n_n (one to three digits) \\\\xxxx_n_n_n the character whose ASCII code is the hexadecimal value _n_n_n (one to three digits) eeeennnnaaaabbbblllleeee [----aaaaddddnnnnppppssss] [----ffff _f_i_l_e_n_a_m_e] [_n_a_m_e ...] Page 5 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) Enable and disable builtin shell commands. Disabling a builtin allows a disk command which has the same name as a shell builtin to be executed with specifying a full pathname, even though the shell normally searches for builtins before disk commands. If ----nnnn is used, each _n_a_m_e is disabled; otherwise, _n_a_m_e_s are enabled. For example, to use the tttteeeesssstttt binary found via the PPPPAAAATTTTHHHH instead of the shell builtin version, run enable -n test.... TTTThhhheeee ----ffff option means to load the new builtin command _n_a_m_e from shared object _f_i_l_e_n_a_m_e, on systems that support dynamic loading. The ----dddd option will delete a builtin previously loaded with ----ffff. If no _n_a_m_e arguments are given, or if the ----pppp option is supplied, a list of shell builtins is printed. With no other option arguments, the list consists of all enabled shell builtins. If ----nnnn is supplied, only disabled builtins are printed. If ----aaaa is supplied, the list printed includes all builtins, with an indication of whether or not each is enabled. If ----ssss is supplied, the output is restricted to the POSIX _s_p_e_c_i_a_l builtins. The return value is 0 unless a _n_a_m_e is not a shell builtin or there is a problem loading a new builtin from a shared object. eeeevvvvaaaallll [_a_r_g ...] The _a_r_gs are read and concatenated together into a single command. This command is then read and executed by the shell, and its exit status is returned as the value of eeeevvvvaaaallll. If there are no _a_r_g_s, or only null arguments, eeeevvvvaaaallll returns 0. eeeexxxxeeeecccc [----ccccllll] [----aaaa _n_a_m_e] [_c_o_m_m_a_n_d [_a_r_g_u_m_e_n_t_s]] If _c_o_m_m_a_n_d is specified, it replaces the shell. No new process is created. The _a_r_g_u_m_e_n_t_s become the arguments to _c_o_m_m_a_n_d. If the ----llll option is supplied, the shell places a dash in the zeroth arg passed to _c_o_m_m_a_n_d. This is what _l_o_g_i_n(1) does. The ----cccc option causes _c_o_m_m_a_n_d to be executed with an empty environment. If ----aaaa is supplied, the shell passes _n_a_m_e as the zeroth argument to the executed command. If _c_o_m_m_a_n_d cannot be executed for some reason, a non-interactive shell exits, unless the shell option eeeexxxxeeeeccccffffaaaaiiiillll is enabled, in which case it returns failure. An interactive shell returns failure if the file cannot be executed. If _c_o_m_m_a_n_d is not specified, any redirections take effect in the current shell, and the return status is 0. If there is a redirection error, the return status is 1. eeeexxxxiiiitttt [_n] Cause the shell to exit with a status of _n. If _n is omitted, the exit status is that of the last command executed. A trap on EEEEXXXXIIIITTTT is executed before the shell Page 6 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) terminates. eeeexxxxppppoooorrrrtttt [----ffffnnnn] [_n_a_m_e[=_w_o_r_d]] ... eeeexxxxppppoooorrrrtttt ----pppp The supplied _n_a_m_e_s are marked for automatic export to the environment of subsequently executed commands. If the ----ffff option is given, the _n_a_m_e_s refer to functions. If no _n_a_m_e_s are given, or if the ----pppp option is supplied, a list of all names that are exported in this shell is printed. The ----nnnn option causes the export property to be removed from the named variables. eeeexxxxppppoooorrrrtttt returns an exit status of 0 unless an invalid option is encountered, one of the _n_a_m_e_s is not a valid shell variable name, or ----ffff is supplied with a _n_a_m_e that is not a function. ffffcccc [----eeee _e_n_a_m_e] [----nnnnllllrrrr] [_f_i_r_s_t] [_l_a_s_t] ffffcccc ----ssss [_p_a_t=_r_e_p] [_c_m_d] Fix Command. In the first form, a range of commands from _f_i_r_s_t to _l_a_s_t is selected from the history list. _F_i_r_s_t and _l_a_s_t may be specified as a string (to locate the last command beginning with that string) or as a number (an index into the history list, where a negative number is used as an offset from the current command number). If _l_a_s_t is not specified it is set to the current command for listing (so that ffffcccc ----llll ----11110000 prints the last 10 commands) and to _f_i_r_s_t otherwise. If _f_i_r_s_t is not specified it is set to the previous command for editing and -16 for listing. The ----nnnn option suppresses the command numbers when listing. The ----rrrr option reverses the order of the commands. If the ----llll option is given, the commands are listed on standard output. Otherwise, the editor given by _e_n_a_m_e is invoked on a file containing those commands. If _e_n_a_m_e is not given, the value of the FFFFCCCCEEEEDDDDIIIITTTT variable is used, and the value of EEEEDDDDIIIITTTTOOOORRRR if FFFFCCCCEEEEDDDDIIIITTTT is not set. If neither variable is set, is used. When editing is complete, the edited commands are echoed and executed. In the second form, _c_o_m_m_a_n_d is re-executed after each instance of _p_a_t is replaced by _r_e_p. A useful alias to use with this is ``r=fc -s'', so that typing ``r cc'' runs the last command beginning with ``cc'' and typing ``r'' re-executes the last command. If the first form is used, the return value is 0 unless an invalid option is encountered or _f_i_r_s_t or _l_a_s_t specify history lines out of range. If the ----eeee option is supplied, the return value is the value of the last command executed or failure if an error occurs with the Page 7 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) temporary file of commands. If the second form is used, the return status is that of the command re- executed, unless _c_m_d does not specify a valid history line, in which case ffffcccc returns failure. ffffgggg [_j_o_b_s_p_e_c] Resume _j_o_b_s_p_e_c in the foreground, and make it the current job. If _j_o_b_s_p_e_c is not present, the shell's notion of the _c_u_r_r_e_n_t _j_o_b is used. The return value is that of the command placed into the foreground, or failure if run when job control is disabled or, when run with job control enabled, if _j_o_b_s_p_e_c does not specify a valid job or _j_o_b_s_p_e_c specifies a job that was started without job control. ggggeeeettttooooppppttttssss _o_p_t_s_t_r_i_n_g _n_a_m_e [_a_r_g_s] ggggeeeettttooooppppttttssss is used by shell procedures to parse positional parameters. _o_p_t_s_t_r_i_n_g contains the option letters to be recognized; if a letter is followed by a colon, the option is expected to have an argument, which should be separated from it by white space. Each time it is invoked, ggggeeeettttooooppppttttssss places the next option in the shell variable _n_a_m_e, initializing _n_a_m_e if it does not exist, and the index of the next argument to be processed into the variable OOOOPPPPTTTTIIIINNNNDDDD. OOOOPPPPTTTTIIIINNNNDDDD is initialized to 1 each time the shell or a shell script is invoked. When an option requires an argument, ggggeeeettttooooppppttttssss places that argument into the variable OOOOPPPPTTTTAAAARRRRGGGG. The shell does not reset OOOOPPPPTTTTIIIINNNNDDDD automatically; it must be manually reset between multiple calls to ggggeeeettttooooppppttttssss within the same shell invocation if a new set of parameters is to be used. When the end of options is encountered, ggggeeeettttooooppppttttssss exits with a return value greater than zero. OOOOPPPPTTTTIIIINNNNDDDD is set to the index of the first non-option argument, and nnnnaaaammmmeeee is set to ?. ggggeeeettttooooppppttttssss normally parses the positional parameters, but if more arguments are given in _a_r_g_s, ggggeeeettttooooppppttttssss parses those instead. ggggeeeettttooooppppttttssss can report errors in two ways. If the first character of _o_p_t_s_t_r_i_n_g is a colon, _s_i_l_e_n_t error reporting is used. In normal operation diagnostic messages are printed when invalid options or missing option arguments are encountered. If the variable OOOOPPPPTTTTEEEERRRRRRRR is set to 0, no error messages will be displayed, even if the first character of _o_p_t_s_t_r_i_n_g is not a colon. If an invalid option is seen, ggggeeeettttooooppppttttssss places ? into _n_a_m_e and, if not silent, prints an error message and Page 8 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) unsets OOOOPPPPTTTTAAAARRRRGGGG. If ggggeeeettttooooppppttttssss is silent, the option character found is placed in OOOOPPPPTTTTAAAARRRRGGGG and no diagnostic message is printed. If a required argument is not found, and ggggeeeettttooooppppttttssss is not silent, a question mark (????) is placed in _n_a_m_e, OOOOPPPPTTTTAAAARRRRGGGG is unset, and a diagnostic message is printed. If ggggeeeettttooooppppttttssss is silent, then a colon (::::) is placed in _n_a_m_e and OOOOPPPPTTTTAAAARRRRGGGG is set to the option character found. ggggeeeettttooooppppttttssss returns true if an option, specified or unspecified, is found. It returns false if the end of options is encountered or an error occurs. hhhhaaaasssshhhh [----rrrr] [----pppp _f_i_l_e_n_a_m_e] [_n_a_m_e] For each _n_a_m_e, the full file name of the command is determined by searching the directories in $$$$PPPPAAAATTTTHHHH and remembered. If the ----pppp option is supplied, no path search is performed, and _f_i_l_e_n_a_m_e is used as the full file name of the command. The ----rrrr option causes the shell to forget all remembered locations. If no arguments are given, information about remembered commands is printed. The return status is true unless a _n_a_m_e is not found or an invalid option is supplied. hhhheeeellllpppp [_p_a_t_t_e_r_n] Display helpful information about builtin commands. If _p_a_t_t_e_r_n is specified, hhhheeeellllpppp gives detailed help on all commands matching _p_a_t_t_e_r_n; otherwise help for all the builtins and shell control structures is printed. The return status is 0 unless no command matches _p_a_t_t_e_r_n. hhhhiiiissssttttoooorrrryyyy [----cccc] [_n] hhhhiiiissssttttoooorrrryyyy ----aaaannnnrrrrwwww [_f_i_l_e_n_a_m_e] hhhhiiiissssttttoooorrrryyyy ----pppp _a_r_g [_a_r_g ...] hhhhiiiissssttttoooorrrryyyy ----ssss _a_r_g [_a_r_g ...] With no options, display the command history list with line numbers. Lines listed with a **** have been modified. An argument of _n lists only the last _n lines. If _f_i_l_e_n_a_m_e is supplied, it is used as the name of the history file; if not, the value of HHHHIIIISSSSTTTTFFFFIIIILLLLEEEE is used. Options, if supplied, have the following meanings: ----aaaa Append the ``new'' history lines (history lines entered since the beginning of the current bbbbaaaasssshhhh session) to the history file. ----nnnn Read the history lines not already read from the history file into the current history list. These are lines appended to the history file since the beginning of the current bbbbaaaasssshhhh session. ----rrrr Read the contents of the history file and use them as the current history. Page 9 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) ----wwww Write the current history to the history file, overwriting the history file's contents. ----cccc Clear the history list by deleting all the entries. ----pppp Perform history substitution on the following _a_r_g_s and display the result on the standard output. Does not store the results in the history list. Each _a_r_g must be quoted to disable normal history expansion. ----ssss Store the _a_r_g_s in the history list as a single entry. The last command in the history list is removed before the _a_r_g_s are added. The return value is 0 unless an invalid option is encountered or an error occurs while reading or writing the history file. jjjjoooobbbbssss [----llllnnnnpppprrrrssss] [ _j_o_b_s_p_e_c ... ] jjjjoooobbbbssss ----xxxx _c_o_m_m_a_n_d [ _a_r_g_s ... ] The first form lists the active jobs. The options have the following meanings: ----llll List process IDs in addition to the normal information. ----pppp List only the process ID of the job's process group leader. ----nnnn Display information only about jobs that have changed status since the user was last notified of their status. ----rrrr Restrict output to running jobs. ----ssss Restrict output to stopped jobs. If _j_o_b_s_p_e_c is given, output is restricted to information about that job. The return status is 0 unless an invalid option is encountered or an invalid _j_o_b_s_p_e_c is supplied. If the ----xxxx option is supplied, jjjjoooobbbbssss replaces any _j_o_b_s_p_e_c found in _c_o_m_m_a_n_d or _a_r_g_s with the corresponding process group ID, and executes _c_o_m_m_a_n_d passing it _a_r_g_s, returning its exit status. kkkkiiiillllllll [----ssss _s_i_g_s_p_e_c | ----nnnn _s_i_g_n_u_m | ----_s_i_g_s_p_e_c] [_p_i_d | _j_o_b_s_p_e_c] ... kkkkiiiillllllll ----llll [_s_i_g_s_p_e_c | _e_x_i_t__s_t_a_t_u_s] Send the signal named by _s_i_g_s_p_e_c or _s_i_g_n_u_m to the processes named by _p_i_d or _j_o_b_s_p_e_c. _s_i_g_s_p_e_c is either a signal name such as SSSSIIIIGGGGKKKKIIIILLLLLLLL or a signal number; _s_i_g_n_u_m is a signal number. If _s_i_g_s_p_e_c is a signal name, the name may be given with or without the SSSSIIIIGGGG prefix. If _s_i_g_s_p_e_c is not present, then SSSSIIIIGGGGTTTTEEEERRRRMMMM is assumed. An argument of ----llll lists the signal names. If any arguments are supplied when ----llll is given, the names of the signals corresponding to the arguments are listed, Page 10 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) and the return status is 0. The _e_x_i_t__s_t_a_t_u_s argument to ----llll is a number specifying either a signal number or the exit status of a process terminated by a signal. kkkkiiiillllllll returns true if at least one signal was successfully sent, or false if an error occurs or an invalid option is encountered. lllleeeetttt _a_r_g [_a_r_g ...] Each _a_r_g is an arithmetic expression to be evaluated (see AAAARRRRIIIITTTTHHHHMMMMEEEETTTTIIIICCCC EEEEVVVVAAAALLLLUUUUAAAATTTTIIIIOOOONNNN). If the last _a_r_g evaluates to 0, lllleeeetttt returns 1; 0 is returned otherwise. llllooooccccaaaallll [_n_a_m_e[=_v_a_l_u_e] ...] For each argument, a local variable named _n_a_m_e is created, and assigned _v_a_l_u_e. When llllooooccccaaaallll is used within a function, it causes the variable _n_a_m_e to have a visible scope restricted to that function and its children. With no operands, llllooooccccaaaallll writes a list of local variables to the standard output. It is an error to use llllooooccccaaaallll when not within a function. The return status is 0 unless llllooooccccaaaallll is used outside a function, or an invalid _n_a_m_e is supplied. llllooooggggoooouuuutttt Exit a login shell. ppppooooppppdddd [-nnnn] [+_n] [-_n] Removes entries from the directory stack. With no arguments, removes the top directory from the stack, and performs a ccccdddd to the new top directory. Arguments, if supplied, have the following meanings: ++++_n Removes the _nth entry counting from the left of the list shown by ddddiiiirrrrssss, starting with zero. For example: ``popd +0'' removes the first directory, ``popd +1'' the second. ----_n Removes the _nth entry counting from the right of the list shown by ddddiiiirrrrssss, starting with zero. For example: ``popd -0'' removes the last directory, ``popd -1'' the next to last. ----nnnn Suppresses the normal change of directory when removing directories from the stack, so that only the stack is manipulated. If the ppppooooppppdddd command is successful, a ddddiiiirrrrssss is performed as well, and the return status is 0. ppppooooppppdddd returns false if an invalid option is encountered, the directory stack is empty, a non-existent directory stack entry is specified, or the directory change fails. pppprrrriiiinnnnttttffff _f_o_r_m_a_t [_a_r_g_u_m_e_n_t_s] Write the formatted _a_r_g_u_m_e_n_t_s to the standard output Page 11 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) under the control of the _f_o_r_m_a_t. The _f_o_r_m_a_t is a character string which contains three types of objects: plain characters, which are simply copied to standard output, character escape sequences, which are converted and copied to the standard output, and format specifications, each of which causes printing of the next successive _a_r_g_u_m_e_n_t. In addition to the standard _p_r_i_n_t_f(1) formats, %b causes pppprrrriiiinnnnttttffff to expand backslash escape sequences in the corresponding _a_r_g_u_m_e_n_t, and %q causes pppprrrriiiinnnnttttffff to output the corresponding _a_r_g_u_m_e_n_t in a format that can be reused as shell input. The _f_o_r_m_a_t is reused as necessary to consume all of the _a_r_g_u_m_e_n_t_s. If the _f_o_r_m_a_t requires more _a_r_g_u_m_e_n_t_s than are supplied, the extra format specifications behave as if a zero value or null string, as appropriate, had been supplied. ppppuuuusssshhhhdddd [----nnnn] [_d_i_r] ppppuuuusssshhhhdddd [----nnnn] [+_n] [-_n] Adds a directory to the top of the directory stack, or rotates the stack, making the new top of the stack the current working directory. With no arguments, exchanges the top two directories and returns 0, unless the directory stack is empty. Arguments, if supplied, have the following meanings: ++++_n Rotates the stack so that the _nth directory (counting from the left of the list shown by ddddiiiirrrrssss, starting with zero) is at the top. ----_n Rotates the stack so that the _nth directory (counting from the right of the list shown by ddddiiiirrrrssss, starting with zero) is at the top. ----nnnn Suppresses the normal change of directory when adding directories to the stack, so that only the stack is manipulated. ddddiiiirrrr Adds _d_i_r to the directory stack at the top, making it the new current working directory. If the ppppuuuusssshhhhdddd command is successful, a ddddiiiirrrrssss is performed as well. If the first form is used, ppppuuuusssshhhhdddd returns 0 unless the cd to _d_i_r fails. With the second form, ppppuuuusssshhhhdddd returns 0 unless the directory stack is empty, a non-existent directory stack element is specified, or the directory change to the specified new current directory fails. ppppwwwwdddd [----LLLLPPPP] Print the absolute file name of the current working directory. The file name printed contains no symbolic links if the ----PPPP option is supplied or the ----oooo pppphhhhyyyyssssiiiiccccaaaallll option to the sssseeeetttt builtin command is enabled. If the ----LLLL option is used, symbolic links are followed. The Page 12 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) return status is 0 unless an error occurs while reading the name of the current directory or an invalid option is supplied. rrrreeeeaaaadddd [----eeeerrrr] [----aaaa _a_n_a_m_e] [----pppp _p_r_o_m_p_t] [_n_a_m_e ...] One line is read from the standard input, and the first word is assigned to the first _n_a_m_e, the second word to the second _n_a_m_e, and so on, with leftover words and their intervening separators assigned to the last _n_a_m_e. If there are fewer words read from the standard input than names, the remaining names are assigned empty values. The characters in IIIIFFFFSSSS are used to split the line into words. The backslash character (\\\\) may be used to remove any special meaning for the next character read and for line continuation. Options, if supplied, have the following meanings: ----rrrr Backslash does not act as an escape character. The backslash is considered to be part of the line. In particular, a backslash-newline pair may not be used as a line continuation. ----pppp Display _p_r_o_m_p_t, without a trailing newline, before attempting to read any input. The prompt is displayed only if input is coming from a terminal. ----aaaa The words are assigned to sequential indices of the array variable _a_n_a_m_e, starting at 0. _a_n_a_m_e is unset before any new values are assigned. Other _n_a_m_e arguments are ignored. ----eeee If the standard input is coming from a terminal, rrrreeeeaaaaddddlllliiiinnnneeee (see RRRREEEEAAAADDDDLLLLIIIINNNNEEEE above) is used to obtain the line. If no _n_a_m_e_s are supplied, the line read is assigned to the variable RRRREEEEPPPPLLLLYYYY. The return code is zero, unless end-of-file is encountered. rrrreeeeaaaaddddoooonnnnllllyyyy [----aaaappppffff] [_n_a_m_e ...] The given _n_a_m_e_s are marked readonly; the values of these _n_a_m_e_s may not be changed by subsequent assignment. If the ----ffff option is supplied, the functions corresponding to the _n_a_m_e_s are so marked. The ----aaaa option restricts the variables to arrays. If no _n_a_m_e arguments are given, or if the ----pppp option is supplied, a list of all readonly names is printed. The ----pppp option causes output to be displayed in a format thatmay be reused as input. The return status is 0 unless an invalid option is encountered, one of the _n_a_m_e_s is not a valid shell variable name, or ----ffff is supplied with a _n_a_m_e that is not a function. rrrreeeettttuuuurrrrnnnn [_n] Causes a function to exit with the return value specified by _n. If _n is omitted, the return status is Page 13 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) that of the last command executed in the function body. If used outside a function, but during execution of a script by the .... (ssssoooouuuurrrrcccceeee) command, it causes the shell to stop executing that script and return either _n or the exit status of the last command executed within the script as the exit status of the script. If used outside a function and not during execution of a script by ...., the return status is false. sssseeeetttt [--------aaaabbbbeeeeffffhhhhkkkkmmmmnnnnppppttttuuuuvvvvxxxxBBBBCCCCHHHHPPPP] [----oooo _o_p_t_i_o_n] [_a_r_g ...] Without options, the name and value of each shell variable are displayed in a format that can be reused as input. The output is sorted according to the current locale. When options are specified, they set or unset shell attributes. Any arguments remaining after the options are processed are treated as values for the positional parameters and are assigned, in order, to $$$$1111, $$$$2222, ............ $$$$_n. Options, if specified, have the following meanings: ----aaaa Automatically mark variables which are modified or created for export to the environment of subsequent commands. ----bbbb Report the status of terminated background jobs immediately, rather than before the next primary prompt. This is effective only when job control is enabled. ----eeee Exit immediately if a _s_i_m_p_l_e _c_o_m_m_a_n_d (see SSSSHHHHEEEELLLLLLLL GGGGRRRRAAAAMMMMMMMMAAAARRRR above) exits with a non-zero status. The shell does not exit if the command that fails is part of an _u_n_t_i_l or _w_h_i_l_e loop, part of an _i_f statement, part of a &&&&&&&& or |||||||| list, or if the command's return value is being inverted via !!!!. ----ffff Disable pathname expansion. ----hhhh Remember the location of commands as they are looked up for execution. This is enabled by default. ----kkkk All arguments in the form of assignment statements are placed in the environment for a command, not just those that precede the command name. ----mmmm Monitor mode. Job control is enabled. This option is on by default for interactive shells on systems that support it (see JJJJOOOOBBBB CCCCOOOONNNNTTTTRRRROOOOLLLL above). Background processes run in a separate process group and a line containing their exit status is printed upon their completion. ----nnnn Read commands but do not execute them. This may be used to check a shell script for syntax errors. This is ignored by interactive shells. ----oooo _o_p_t_i_o_n-_n_a_m_e The _o_p_t_i_o_n-_n_a_m_e can be one of the following: Page 14 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) aaaalllllllleeeexxxxppppoooorrrrtttt Same as ----aaaa. bbbbrrrraaaacccceeeeeeeexxxxppppaaaannnndddd Same as ----BBBB. eeeemmmmaaaaccccssss Use an emacs-style command line editing interface. This is enabled by default when the shell is interactive, unless the shell is started with the --------nnnnooooeeeeddddiiiittttiiiinnnngggg option. eeeerrrrrrrreeeexxxxiiiitttt Same as ----eeee. hhhhaaaasssshhhhaaaallllllll Same as ----hhhh. hhhhiiiisssstttteeeexxxxppppaaaannnndddd Same as ----HHHH. hhhhiiiissssttttoooorrrryyyy Enable command history, as described above under HHHHIIIISSSSTTTTOOOORRRRYYYY. This option is on by default in interactive shells. iiiiggggnnnnoooorrrreeeeeeeeooooffff The effect is as if the shell command IGNOREEOF=10 had been executed (see SSSShhhheeeellllllll VVVVaaaarrrriiiiaaaabbbblllleeeessss above). kkkkeeeeyyyywwwwoooorrrrdddd Same as ----kkkk. mmmmoooonnnniiiittttoooorrrr Same as ----mmmm. nnnnoooocccclllloooobbbbbbbbeeeerrrr Same as ----CCCC. nnnnooooeeeexxxxeeeecccc Same as ----nnnn. nnnnoooogggglllloooobbbb Same as ----ffff. nnnnoooottttiiiiffffyyyy Same as ----bbbb. nnnnoooouuuunnnnsssseeeetttt Same as ----uuuu. oooonnnneeeeccccmmmmdddd Same as ----tttt. pppphhhhyyyyssssiiiiccccaaaallll Same as ----PPPP. ppppoooossssiiiixxxx Change the behavior of bbbbaaaasssshhhh where the default operation differs from the POSIX 1003.2 standard to match the standard. pppprrrriiiivvvviiiilllleeeeggggeeeedddd Same as ----pppp. vvvveeeerrrrbbbboooosssseeee Same as ----vvvv. vvvviiii Use a vi-style command line editing interface. xxxxttttrrrraaaacccceeee Same as ----xxxx. If ----oooo is supplied with no _o_p_t_i_o_n-_n_a_m_e, the values of the current options are printed. If ++++oooo is supplied with no _o_p_t_i_o_n-_n_a_m_e, a series of sssseeeetttt commands to recreate the current option settings is displayed on the standard output. ----pppp Turn on _p_r_i_v_i_l_e_g_e_d mode. In this mode, the $$$$EEEENNNNVVVV and $$$$BBBBAAAASSSSHHHH____EEEENNNNVVVV files are not processed, shell functions are not inherited from the environment, and the SSSSHHHHEEEELLLLLLLLOOOOPPPPTTTTSSSS variable, if it appears in the environment, is ignored. If the shell is started with the effective user Page 15 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) (group) id not equal to the real user (group) id, and the ----pppp option is not supplied, these actions are taken and the effective user id is set to the real user id. If the ----pppp option is supplied at startup, the effective user id is not reset. Turning this option off causes the effective user and group ids to be set to the real user and group ids. ----tttt Exit after reading and executing one command. ----uuuu Treat unset variables as an error when performing parameter expansion. If expansion is attempted on an unset variable, the shell prints an error message, and, if not interactive, exits with a non-zero status. ----vvvv Print shell input lines as they are read. ----xxxx After expanding each _s_i_m_p_l_e _c_o_m_m_a_n_d, display the expanded value of PPPPSSSS4444, followed by the command and its expanded arguments. ----BBBB The shell performs brace expansion (see BBBBrrrraaaacccceeee EEEExxxxppppaaaannnnssssiiiioooonnnn above). This is on by default. ----CCCC If set, bbbbaaaasssshhhh does not overwrite an existing file with the >>>>, >>>>&&&&, and <<<<>>>> redirection operators. This may be overridden when creating output files by using the redirection operator >>>>|||| instead of >>>>. ----HHHH Enable !!!! style history substitution. This option is on by default when the shell is interactive. ----PPPP If set, the shell does not follow symbolic links when executing commands such as ccccdddd that change the current working directory. It uses the physical directory structure instead. By default, bbbbaaaasssshhhh follows the logical chain of directories when performing commands which change the current directory. -------- If no arguments follow this option, then the positional parameters are unset. Otherwise, the positional parameters are set to the _a_r_gs, even if some of them begin with a ----. ---- Signal the end of options, cause all remaining _a_r_gs to be assigned to the positional parameters. The ----xxxx and ----vvvv options are turned off. If there are no _a_r_gs, the positional parameters remain unchanged. The options are off by default unless otherwise noted. Using + rather than - causes these options to be turned off. The options can also be specified as arguments to an invocation of the shell. The current set of options may be found in $$$$----. The return status is always true unless an invalid option is encountered. Page 16 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) sssshhhhiiiifffftttt [_n] The positional parameters from _n+1 ... are renamed to $$$$1111 ................ Parameters represented by the numbers $$$$#### down to $$$$####-_n+1 are unset. _n must be a non-negative number less than or equal to $$$$####. If _n is 0, no parameters are changed. If _n is not given, it is assumed to be 1. If _n is greater than $$$$####, the positional parameters are not changed. The return status is greater than zero if _n is greater than $$$$#### or less than zero; otherwise 0. sssshhhhoooopppptttt [----ppppqqqqssssuuuu] [----oooo] [_o_p_t_n_a_m_e ...] Toggle the values of variables controlling optional shell behavior. With no options, or with the ----pppp option, a list of all settable options is displayed, with an indication of whether or not each is set. The ----pppp option causes output to be displayed in a form that may be reused as input. Other options have the following meanings: ----ssss Enable (set) each _o_p_t_n_a_m_e. ----uuuu Disable (unset) each _o_p_t_n_a_m_e. ----qqqq Suppresses normal output (quiet mode); the return status indicates whether the _o_p_t_n_a_m_e is set or unset. If multiple _o_p_t_n_a_m_e arguments are given with ----qqqq, the return status is zero if all _o_p_t_n_a_m_e_s are enabled; non-zero otherwise. ----oooo Restricts the values of _o_p_t_n_a_m_e to be those defined for the ----oooo option to the sssseeeetttt builtin. If either ----ssss or ----uuuu is used with no _o_p_t_n_a_m_e arguments, the display is limited to those options which are set or unset, respectively. Unless otherwise noted, the sssshhhhoooopppptttt options are disabled (unset) by default. The return status when listing options is zero if all _o_p_t_n_a_m_e_s are enabled, non-zero otherwise. When setting or unsetting options, the return status is zero unless an _o_p_t_n_a_m_e is not a valid shell option. The list of sssshhhhoooopppptttt options is: ccccddddaaaabbbblllleeee____vvvvaaaarrrrssss If set, an argument to the ccccdddd builtin command that is not a directory is assumed to be the name of a variable whose value is the directory to change to. ccccddddssssppppeeeellllllll If set, minor errors in the spelling of a directory component in a ccccdddd command will be corrected. The errors checked for are transposed characters, a missing character, and one character too many. If a correction is found, the corrected file name is printed, and the command proceeds. This option is only used Page 17 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) by interactive shells. cccchhhheeeecccckkkkhhhhaaaasssshhhh If set, bbbbaaaasssshhhh checks that a command found in the hash table exists before trying to execute it. If a hashed command no longer exists, a normal path search is performed. cccchhhheeeecccckkkkwwwwiiiinnnnssssiiiizzzzeeee If set, bbbbaaaasssshhhh checks the window size after each command and, if necessary, updates the values of LLLLIIIINNNNEEEESSSS and CCCCOOOOLLLLUUUUMMMMNNNNSSSS. ccccmmmmddddhhhhiiiisssstttt If set, bbbbaaaasssshhhh attempts to save all lines of a multiple-line command in the same history entry. This allows easy re-editing of multi- line commands. ddddoooottttgggglllloooobbbb If set, bbbbaaaasssshhhh includes filenames beginning with a `.' in the results of pathname expansion. eeeexxxxeeeeccccffffaaaaiiiillll If set, a non-interactive shell will not exit if it cannot execute the file specified as an argument to the eeeexxxxeeeecccc builtin command. An interactive shell does not exit if eeeexxxxeeeecccc fails. eeeexxxxppppaaaannnndddd____aaaalllliiiiaaaasssseeeessss If set, aliases are expanded as described above under AAAALLLLIIIIAAAASSSSEEEESSSS. This option is enabled by default for interactive shells. eeeexxxxttttgggglllloooobbbb If set, the extended pattern matching features described above under PPPPaaaatttthhhhnnnnaaaammmmeeee EEEExxxxppppaaaannnnssssiiiioooonnnn are enabled. hhhhiiiissssttttaaaappppppppeeeennnndddd If set, the history list is appended to the file named by the value of the HHHHIIIISSSSTTTTFFFFIIIILLLLEEEE variable when the shell exits, rather than overwriting the file. hhhhiiiissssttttrrrreeeeeeeeddddiiiitttt If set, and rrrreeeeaaaaddddlllliiiinnnneeee is being used, a user is given the opportunity to re-edit a failed history substitution. hhhhiiiissssttttvvvveeeerrrriiiiffffyyyy If set, and rrrreeeeaaaaddddlllliiiinnnneeee is being used, the results of history substitution are not immediately passed to the shell parser. Instead, the resulting line is loaded into the rrrreeeeaaaaddddlllliiiinnnneeee editing buffer, allowing further modification. hhhhoooossssttttccccoooommmmpppplllleeeetttteeee If set, and rrrreeeeaaaaddddlllliiiinnnneeee is being used, bbbbaaaasssshhhh will attempt to perform hostname completion when a word containing a @@@@ is being completed (see CCCCoooommmmpppplllleeeettttiiiinnnngggg under RRRREEEEAAAADDDDLLLLIIIINNNNEEEE above). This is enabled by default. hhhhuuuuppppoooonnnneeeexxxxiiiitttt If set, bbbbaaaasssshhhh will send SSSSIIIIGGGGHHHHUUUUPPPP to all jobs when an interactive login shell exits. Page 18 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) iiiinnnntttteeeerrrraaaaccccttttiiiivvvveeee____ccccoooommmmmmmmeeeennnnttttssss If set, allow a word beginning with #### to cause that word and all remaining characters on that line to be ignored in an interactive shell (see CCCCOOOOMMMMMMMMEEEENNNNTTTTSSSS above). This option is enabled by default. lllliiiitttthhhhiiiisssstttt If set, and the ccccmmmmddddhhhhiiiisssstttt option is enabled, multi-line commands are saved to the history with embedded newlines rather than using semicolon separators where possible. mmmmaaaaiiiillllwwwwaaaarrrrnnnn If set, and a file that bbbbaaaasssshhhh is checking for mail has been accessed since the last time it was checked, the message ``The mail in _m_a_i_l_f_i_l_e has been read'' is displayed. nnnnooooccccaaaasssseeeegggglllloooobbbb If set, bbbbaaaasssshhhh matches filenames in a case-insensitive fashion when performing pathname expansion (see PPPPaaaatttthhhhnnnnaaaammmmeeee EEEExxxxppppaaaannnnssssiiiioooonnnn above). nnnnuuuullllllllgggglllloooobbbb If set, bbbbaaaasssshhhh allows patterns which match no files (see PPPPaaaatttthhhhnnnnaaaammmmeeee EEEExxxxppppaaaannnnssssiiiioooonnnn above) to expand to a null string, rather than themselves. pppprrrroooommmmppppttttvvvvaaaarrrrssss If set, prompt strings undergo variable and parameter expansion after being expanded as described in PPPPRRRROOOOMMMMPPPPTTTTIIIINNNNGGGG above. This option is enabled by default. rrrreeeessssttttrrrriiiicccctttteeeedddd____sssshhhheeeellllllll The shell sets this option if it is started in restricted mode (see RRRREEEESSSSTTTTRRRRIIIICCCCTTTTEEEEDDDD SSSSHHHHEEEELLLLLLLL below). The value may not be changed. This is not reset when the startup files are executed, allowing the startup files to discover whether or not a shell is restricted. sssshhhhiiiifffftttt____vvvveeeerrrrbbbboooosssseeee If set, the sssshhhhiiiifffftttt builtin prints an error message when the shift count exceeds the number of positional parameters. ssssoooouuuurrrrcccceeeeppppaaaatttthhhh If set, the ssssoooouuuurrrrcccceeee (....) builtin uses the value of PPPPAAAATTTTHHHH to find the directory containing the file supplied as an argument. This option is enabled by default. ssssuuuussssppppeeeennnndddd [----ffff] Suspend the execution of this shell until it receives a SSSSIIIIGGGGCCCCOOOONNNNTTTT signal. The ----ffff option says not to complain if this is a login shell; just suspend anyway. The return status is 0 unless the shell is a login shell and ----ffff is not supplied, or if job control is not enabled. tttteeeesssstttt _e_x_p_r Page 19 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) [[[[ _e_x_p_r ]]]] Return a status of 0 or 1 depending on the evaluation of the conditional expression _e_x_p_r. Each operator and operand must be a separate argument. Expressions are composed of the primaries described above under CCCCOOOONNNNDDDDIIIITTTTIIIIOOOONNNNAAAALLLL EEEEXXXXPPPPRRRREEEESSSSSSSSIIIIOOOONNNNSSSS. Expressions may be combined using the following operators, listed in decreasing order of precedence. !!!! _e_x_p_r True if _e_x_p_r is false. (((( _e_x_p_r )))) Returns the value of _e_x_p_r. This may be used to override the normal precedence of operators. _e_x_p_r_1 -aaaa _e_x_p_r_2 True if both _e_x_p_r_1 and _e_x_p_r_2 are true. _e_x_p_r_1 -oooo _e_x_p_r_2 True if either _e_x_p_r_1 or _e_x_p_r_2 is true. tttteeeesssstttt and [[[[ evaluate conditional expressions using a set of rules based on the number of arguments. 0 arguments The expression is false. 1 argument The expression is true if and only if the argument is not null. 2 arguments If the first argument is !!!!, the expression is true if and only if the second argument is null. If the first argument is one of the unary conditional operators listed above under CCCCOOOONNNNDDDDIIIITTTTIIIIOOOONNNNAAAALLLL EEEEXXXXPPPPRRRREEEESSSSSSSSIIIIOOOONNNNSSSS, the expression is true if the unary test is true. If the first argument is not a valid unary conditional operator, the expression is false. 3 arguments If the second argument is one of the binary conditional operators listed above under CCCCOOOONNNNDDDDIIIITTTTIIIIOOOONNNNAAAALLLL EEEEXXXXPPPPRRRREEEESSSSSSSSIIIIOOOONNNNSSSS, the result of the expression is the result of the binary test using the first and third arguments as operands. If the first argument is !!!!, the value is the negation of the two-argument test using the second and third arguments. If the first argument is exactly (((( and the third argument is exactly )))), the result is the one-argument test of the second argument. Otherwise, the expression is false. The ----aaaa and ----oooo operators are considered binary operators in this case. 4 arguments If the first argument is !!!!, the result is the Page 20 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) negation of the three-argument expression composed of the remaining arguments. Otherwise, the expression is parsed and evaluated according to precedence using the rules listed above. 5 or more arguments The expression is parsed and evaluated according to precedence using the rules listed above. ttttiiiimmmmeeeessss Print the accumulated user and system times for the shell and for processes run from the shell. The return status is 0. ttttrrrraaaapppp [----llllpppp] [_a_r_g] [_s_i_g_s_p_e_c ...] The command _a_r_g is to be read and executed when the shell receives signal(s) _s_i_g_s_p_e_c. If _a_r_g is absent or ----, all specified signals are reset to their original values (the values they had upon entrance to the shell). If _a_r_g is the null string the signal specified by each _s_i_g_s_p_e_c is ignored by the shell and by the commands it invokes. If _a_r_g is ----pppp then the trap commands associated with each _s_i_g_s_p_e_c are displayed. If no arguments are supplied or if only ----pppp is given, ttttrrrraaaapppp prints the list of commands associated with each signal number. Each _s_i_g_s_p_e_c is either a signal name defined in <_s_i_g_n_a_l._h>, or a signal number. If a _s_i_g_s_p_e_c is EEEEXXXXIIIITTTT (0) the command _a_r_g is executed on exit from the shell. If a _s_i_g_s_p_e_c is DDDDEEEEBBBBUUUUGGGG, the command _a_r_g is executed after every _s_i_m_p_l_e _c_o_m_m_a_n_d (see SSSSHHHHEEEELLLLLLLL GGGGRRRRAAAAMMMMMMMMAAAARRRR above). The ----llll option causes the shell to print a list of signal names and their corresponding numbers. Signals ignored upon entry to the shell cannot be trapped or reset. Trapped signals are reset to their original values in a child process when it is created. The return status is false if any _s_i_g_s_p_e_c is invalid; otherwise ttttrrrraaaapppp returns true. ttttyyyyppppeeee [----aaaattttpppp] _n_a_m_e [_n_a_m_e ...] With no options, indicate how each _n_a_m_e would be interpreted if used as a command name. If the ----tttt option is used, ttttyyyyppppeeee prints a string which is one of _a_l_i_a_s, _k_e_y_w_o_r_d, _f_u_n_c_t_i_o_n, _b_u_i_l_t_i_n, or _f_i_l_e if _n_a_m_e is an alias, shell reserved word, function, builtin, or disk file, respectively. If the _n_a_m_e is not found, then nothing is printed, and an exit status of false is returned. If the ----pppp option is used, ttttyyyyppppeeee either returns the name of the disk file that would be executed if _n_a_m_e were specified as a command name, or nothing if type -t name _w_o_u_l_d _n_o_t _r_e_t_u_r_n _f_i_l_e. If a command is hashed, ----pppp prints the hashed value, not necessarily the file that appears first in PPPPAAAATTTTHHHH. If the ----aaaa option is used, ttttyyyyppppeeee prints all of the places Page 21 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) that contain an executable named _n_a_m_e. This includes aliases and functions, if and only if the ----pppp option is not also used. The table of hashed commands is not consulted when using ----aaaa. ttttyyyyppppeeee returns true if any of the arguments are found, false if none are found. uuuulllliiiimmmmiiiitttt [----SSSSHHHHaaaaccccddddffffllllmmmmnnnnppppssssttttuuuuvvvv [_l_i_m_i_t]] Provides control over the resources available to the shell and to processes started by it, on systems that allow such control. The value of _l_i_m_i_t can be a number in the unit specified for the resource, or the value uuuunnnnlllliiiimmmmiiiitttteeeedddd. The ----HHHH and ----SSSS options specify that the hard or soft limit is set for the given resource. A hard limit cannot be increased once it is set; a soft limit may be increased up to the value of the hard limit. If neither ----HHHH nor ----SSSS is specified, both the soft and hard limits are set. If _l_i_m_i_t is omitted, the current value of the soft limit of the resource is printed, unless the ----HHHH option is given. When more than one resource is specified, the limit name and unit are printed before the value. Other options are interpreted as follows: ----aaaa All current limits are reported ----cccc The maximum size of core files created ----dddd The maximum size of a process's data segment ----ffff The maximum size of files created by the shell ----llll The maximum size that may be locked into memory ----mmmm The maximum resident set size ----nnnn The maximum number of open file descriptors (most systems do not allow this value to be set) ----pppp The pipe size in 512-byte blocks (this may not be set) ----ssss The maximum stack size ----tttt The maximum amount of cpu time in seconds ----uuuu The maximum number of processes available to a single user ----vvvv The maximum amount of virtual memory available to the shell If _l_i_m_i_t is given, it is the new value of the specified resource (the ----aaaa option is display only). If no option is given, then ----ffff is assumed. Values are in 1024-byte increments, except for ----tttt, which is in seconds, ----pppp, which is in units of 512-byte blocks, and ----nnnn and ----uuuu, which are unscaled values. The return status is 0 unless an invalid option is encountered, a non-numeric argument other than uuuunnnnlllliiiimmmmiiiitttteeeedddd is supplied as _l_i_m_i_t, or an error occurs while setting a new limit. uuuummmmaaaasssskkkk [----pppp] [----SSSS] [_m_o_d_e] The user file-creation mask is set to _m_o_d_e. If _m_o_d_e begins with a digit, it is interpreted as an octal number; otherwise it is interpreted as a symbolic mode Page 22 (printed 3/25/99) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) GGGGNNNNUUUU ((((1111999999996666 MMMMaaaarrrrcccchhhh 22220000)))) BBBBAAAASSSSHHHH____BBBBUUUUIIIILLLLTTTTIIIINNNNSSSS((((1111)))) mask similar to that accepted by _c_h_m_o_d(1). If _m_o_d_e is omitted, or if the ----SSSS option is supplied, the current value of the mask is printed. The ----SSSS option causes the mask to be printed in symbolic form; the default output is an octal number. If the ----pppp option is supplied, and _m_o_d_e is omitted, the output is in a form that may be reused as input. The return status is 0 if the mode was successfully changed or if no _m_o_d_e argument was supplied, and false otherwise. uuuunnnnaaaalllliiiiaaaassss [-aaaa] [_n_a_m_e ...] Remove _n_a_m_es from the list of defined aliases. If ----aaaa is supplied, all alias definitions are removed. The return value is true unless a supplied _n_a_m_e is not a defined alias. uuuunnnnsssseeeetttt [-ffffvvvv] [_n_a_m_e ...] For each _n_a_m_e, remove the corresponding variable or function. If no options are supplied, or the ----vvvv option is given, each _n_a_m_e refers to a shell variable. Read- only variables may not be unset. If ----ffff is specifed, each _n_a_m_e refers to a shell function, and the function definition is removed. Each unset variable or function is removed from the environment passed to subsequent commands. If any of RRRRAAAANNNNDDDDOOOOMMMM, SSSSEEEECCCCOOOONNNNDDDDSSSS, LLLLIIIINNNNEEEENNNNOOOO, HHHHIIIISSSSTTTTCCCCMMMMDDDD, or DDDDIIIIRRRRSSSSTTTTAAAACCCCKKKK are unset, they lose their special properties, even if they are subsequently reset. The exit status is true unless a _n_a_m_e does not exist or is readonly. wwwwaaaaiiiitttt [_n] Wait for the specified process and return its termination status. _n may be a process ID or a job specification; if a job spec is given, all processes in that job's pipeline are waited for. If _n is not given, all currently active child processes are waited for, and the return status is zero. If _n specifies a non- existent process or job, the return status is 127. Otherwise, the return status is the exit status of the last process or job waited for. SSSSEEEEEEEE AAAALLLLSSSSOOOO bash(1), sh(1) Page 23 (printed 3/25/99)